require-relative

What is require-relative?

The require-relative npm package allows you to require modules relative to a given path, rather than relative to the current module. This can be particularly useful in large projects where you need to manage dependencies in a more flexible way.

What are require-relative's main functionalities?

Require a module relative to a given path

This feature allows you to require a module relative to a specified base path. In the code sample, `./myModule` is required relative to `/path/to/base`.

const requireRelative = require('require-relative');
const myModule = requireRelative('./myModule', '/path/to/base');

Resolve a module path relative to a given path

This feature allows you to resolve the path of a module relative to a specified base path without actually requiring it. In the code sample, the path to `./myModule` is resolved relative to `/path/to/base`.

const requireRelative = require('require-relative');
const modulePath = requireRelative.resolve('./myModule', '/path/to/base');

Other packages similar to require-relative

app-module-path

The app-module-path package allows you to add custom directories to the Node.js module search path. This can be useful for setting up a more flexible module resolution strategy, similar to require-relative, but it works by modifying the global module search path rather than resolving paths relative to a given base.

module-alias

The module-alias package allows you to create custom module aliases and register directories for module resolution. This package provides a more comprehensive solution for managing module paths and aliases, offering more flexibility compared to require-relative.

resolve

The resolve package is a library for resolving module paths in Node.js. It provides a low-level API for resolving module paths, similar to the resolve feature in require-relative, but with more control and options for customizing the resolution process.

README

require-relative

require-relative is a node.js program to require and resolve modules relative to a path of your choice. It exploits node.js's own module module, and has no additional dependencies.

Example

requiring modules relatively

var relative = require('require-relative');

var someModule = relative('./some-module', '/home/kamicane');
var somePackage = relative('some-package', '/home/kamicane');
var isTrue = relative('./some-module.js', process.cwd()) === relative('./some-module.js');

resolving filenames relatively

var relative = require('require-relative');

relative.resolve('./some-module', '/home/kamicane'); // /home/kamicane/some-module.js
relative.resolve('some-package', '/home/kamicane'); // /home/kamicane/node_modules/some-package/index.js
var isTrue = relative.resolve('./some-module.js', process.cwd()) === relative.resolve('./some-module.js');